Added config option for auto-detecting plot content in Examples #96
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
elevates the hard-coded ``'import matplotlib'`` trigger for using matplotlib's plot directive to an extension config parameter, called `numpydoc_plot_examples_re`
|
Matplotlib's plot_directive has such an option, so this does not seem
fully necessary to add?
|
|
Sorry, misread the PR, my comment above is not relevant.
|
|
If this was just about supporting |
|
Given that |
jnothman
added a commit
to jnothman/numpydoc
that referenced
this pull request
Oct 24, 2017
jnothman
added a commit
to jnothman/numpydoc
that referenced
this pull request
Oct 24, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a new config option
numpydoc_plot_examples_reto allow for easy customisation of the required content for inserting plot directives in Examples sections. The default remains'import matplotlib'.For example, if the user code doesn't include a direct matplotlib import, but rather imports
pyplotasfrom matplotlib import pyplot, currently that wouldn't allow for auto-inserting a plot directive, but with the new parameter, they can tell numpydoc from theconf.py: